Docs: Remove stale reference to closed #2152 in streaming write docstrings#3597
Closed
qzyu999 wants to merge 1 commit into
Closed
Docs: Remove stale reference to closed #2152 in streaming write docstrings#3597qzyu999 wants to merge 1 commit into
qzyu999 wants to merge 1 commit into
Conversation
Author
|
Did a reanalysis of the issue in the docstring, although it's not directly discussing partitioned streaming, there is discussion about it there. Not worth removing the issue reference in that case. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rationale for this change
Issue #2152 was closed by #3335 (commit 706390f) which added pa.RecordBatchReader support for unpartitioned streaming writes. However, the docstrings in _dataframe_to_data_files, Transaction.append, and Transaction.overwrite still reference #2152 as if it tracks future partitioned streaming support. Since the issue is closed, these references are stale and misleading.
This PR removes the now-incorrect
tracked in #2152/See #2152links from docstrings and the NotImplementedError message, replacing them with a simple statement that partitioned streaming is not yet implemented.Are these changes tested?
Docstring-only changes; no behavioral changes. Existing tests pass as-is.
Are there any user-facing changes?
The NotImplementedError message when passing a pa.RecordBatchReader to a partitioned table is slightly shorter (no longer includes the closed issue URL). No API or behavioral changes.